Lender Price API
Locking a Loan with LOS / 7. Request Lock / 7.1 Check Lock Desk Hour
In This Topic
    7.1 Check Lock Desk Hour
    In This Topic

    Loan providers have operating hours where price concessions can be entered. These operating hours are referred to as desk hours, and they differ based on the loan provider. Before entering a price concession, first confirm that the request was made during the loan provider's desk hours. This check is done using the checkLockStatus call.

    Provide the lockId and statusId returned by the addLockEvent call in the Add Export Pricing Lock Event step.

    Path

     /rest/v1/lp-ppe-api/checkLockStatus/{lockId}/{statusId}

    Headers
    secret

    {{token}}

    companyid

    {{companyId}}

    Path Parameters

    The {lockId} is the lockId returned by from the addLockEvent call in the Add Export Pricing Lock Event step.

    The {statusId} from the same lock.

    Note: If you are making this adjustment after the statusId has been altered by other actions you have taken after the initial lock event, be sure to provide the proper statusId.

    Body

    This call has no body.

    Response

    The call will respond with the status of the lock, including the loan's desk hours. The relevant fields are listed under lockExemptDates: